ember-template-lint
Advanced tools
ember-template-lint is a linting tool for Ember.js templates. It helps developers maintain consistent coding styles, catch potential errors, and enforce best practices in Handlebars templates.
Linting Templates
This feature allows you to lint your Handlebars templates to ensure they follow specific rules. For example, the 'no-bare-strings' rule prevents the use of bare strings in templates, encouraging the use of translation helpers instead.
module.exports = { 'no-bare-strings': true };Custom Rules
You can define custom linting rules to enforce specific coding standards within your project. In this example, the 'no-inline-styles' rule is set to 'error' severity, which will flag any inline styles in templates as errors.
module.exports = { rules: { 'no-inline-styles': { severity: 'error' } } };Configuration File
You can extend from predefined configurations to quickly set up linting rules. The 'recommended' configuration includes a set of rules that are generally considered best practices for Ember.js templates.
module.exports = { extends: 'recommended' };ESLint is a widely-used linting tool for JavaScript. It helps developers find and fix problems in their JavaScript code. While ESLint focuses on JavaScript, ember-template-lint is specifically designed for Handlebars templates in Ember.js.
Stylelint is a linter for CSS and other stylesheets. It helps enforce consistent conventions and avoid errors in stylesheets. Like ember-template-lint, it is highly configurable, but it focuses on styles rather than Handlebars templates.
ember-cli-template-lint is an older package that integrates template linting into the Ember CLI build process. It has been largely superseded by ember-template-lint, which offers more features and better integration.
ember-template-lint will lint your handlebars template and return error results.
For example, given the rule no-bare-strings is enabled, this template would be
in violation:
{{!-- app/components/my-thing/template.hbs --}}
<div>A bare string</div>
When the ember-template-lint executable is run, we would have a single result indicating that
the no-bare-strings rule found an error.
This addon is installed by default with new Ember apps, so check your package.json before installing to see if you need to install it.
To install ember-template-lint
With npm:
npm install --save-dev ember-template-lint
With yarn:
yarn add ember-template-lint --dev
Node.js 10 || >=12 is required.
While ember-template-lint does have a Node API, the main way to use it is through its executable, which is intended to be installed locally within a project.
Basic usage is as straightforward as
ember-template-lint .
Basic usage with a single file
ember-template-lint "app/templates/application.hbs"
Output errors with source description
ember-template-lint "app/templates/application.hbs" --verbose
Multiple file/directory/wildcard paths are accepted
ember-template-lint "app/templates/components/**/*" "app/templates/application.hbs"
Output errors as pretty-printed JSON string
ember-template-lint "app/templates/application.hbs" --json
Ignore warnings / only report errors
ember-template-lint "app/templates/application.hbs" --quiet
Number of warnings to trigger nonzero exit code
ember-template-lint "app/templates/application.hbs" --max-warnings=2
Define custom config path
ember-template-lint "app/templates/application.hbs" --config-path .my-template-lintrc.js
Read from stdin
ember-template-lint --filename app/templates/application.hbs < app/templates/application.hbs
Print list of formatted rules for use with pending in config file
ember-template-lint "app/templates/application.hbs" --print-pending
Specify custom ignore pattern ['**/dist/**', '**/tmp/**', '**/node_modules/**'] by default
ember-template-lint "/tmp/template.hbs" --ignore-pattern "**/foo/**" --ignore-pattern "**/bar/**"
Disable ignore pattern entirely
ember-template-lint "/tmp/template.hbs" --no-ignore-pattern
Running a single rule without options
ember-template-lint --no-config-path app/templates --rule 'no-implicit-this:error'
Running a single rule with options
ember-template-lint --no-config-path app/templates --rule 'no-implicit-this:["error", { "allow": ["some-helper"] }]'
Running a single rule, disabling inline configuration
ember-template-lint --no-config-path app/templates --rule 'no-implicit-this:error' --no-inline-config
Specify a config object to use instead of what exists locally
ember-template-lint --config '{ "rules": { "no-implicit-this": { "severity": 2, "config": true } } }' test/fixtures/no-implicit-this-allow-with-regexp/app/templates
:bulb: Ensure you wrap all glob patterns in quotes so that it won't be interpreted by the CLI. ember-template-lint app/templates/** (this will expand all paths in app/templates) and ember-template-lint "app/templates/**" (this will pass the glob to ember-template-lint and not interpret the glob).
You can turn on specific rules by toggling them in a
.template-lintrc.js file at the base of your project, or at a custom relative
path which may be identified using the CLI:
module.exports = {
extends: 'recommended',
rules: {
'no-bare-strings': true,
},
};
For more detailed information see configuration.
| Name | Description | |
|---|---|---|
| :white_check_mark: | recommended | enables the recommended rules |
| :car: | octane | extends the recommended preset by enabling Ember Octane rules |
| :nail_care: | stylistic | enables stylistic rules for those who aren't ready to adopt ember-template-lint-plugin-prettier (including stylistic rules that were previously in the recommended preset in ember-template-lint v1) |
Each rule has emojis denoting:
--fix command line option--fix optionYou can add a fixer to a rule. See fixer documentation for more details.
It is possible to share a config (extends) or plugin (custom rules) across projects. See ember-template-lint-plugin-peopleconnect for an example.
You can define and use your own custom rules using the plugin system. See plugin documentation for more details.
The semver policy for this addon can be read here: semver policy.
See the Contributing Guidelines for information on how to help out.
This project is licensed under the MIT License.
FAQs
Linter for Ember or Handlebars templates.
The npm package ember-template-lint receives a total of 106,303 weekly downloads. As such, ember-template-lint popularity was classified as popular.
We found that ember-template-lint demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 7 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
An advanced npm supply chain attack is leveraging Ethereum smart contracts for decentralized, persistent malware control, evading traditional defenses.
Security News
Research
Attackers are impersonating Sindre Sorhus on npm with a fake 'chalk-node' package containing a malicious backdoor to compromise developers' projects.
Security News
The npm package for the LottieFiles Player web component was hit with a supply chain attack after a software engineer's npmjs credentials were compromised.